Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document data #2049

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

focardozom
Copy link

Potential fix for #1681. Here’s a summary of the relevant points discussed in the issue:

  1. Existing Tools: The sinew package provides functions for documenting, but its workflow might overlap with usethis. More details can be found in the workflow guide.

  2. Alternative Solution: Another approach is proposed here, which handles various R objects and offers customizable documentation. However, it may require style translation and simplification to make it more accessible.

  3. This Pull Request: The use_document_data function is simpler and easier to read, though it doesn’t offer the same level of customization as the alternative.

@jennybc
Copy link
Member

jennybc commented Aug 23, 2024

This isn't a full review, but I came by quickly to see if this pkgdown failure is related to one seen in a different PR. It doesn't seem to be.

The pkgdown CI failure appears to be real because the new functions need to be added to the reference index. So that would be good to fix up to make this PR complete.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants